home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / GRAPHICS / RAYTRACING / POVRAY-2.2 / POVFRONT / !POVray2 / !Help < prev    next >
Text File  |  1994-07-06  |  9KB  |  175 lines
  1. Persistence of Vision V2 Front-end Program
  2. ==========================================
  3.  
  4. Introduction 
  5. ------------ 
  6.  
  7. This application provides a convenient desktop based front end to the
  8. Persistence of Vision Ray Tracer. It allows you to control virtually all of
  9. the options available under POV from icons and menus, and makes POV a lot
  10. easier to use under RISC OS. In the documentation below, POV or 'the
  11. executable' refers to the Persistence of Vision Public Domain Ray Tracer
  12. Program. The Persistence of Vision ray tracer is copyright by the 
  13. POV team, and you should read the documentation accompanying it for
  14. more information. '!POVray2' refers to this application. I have not been
  15. able to test !POVray2 under RISC OS 2, but as far as I know, it should work
  16. correctly under both RISC OS 2 and RISC OS 3. Note, however, that under
  17. RISC OS 2, the enhanced 'features' such as 3D windows and solid icon
  18. drags (see below) will not be available. I'm afraid I don't have the money
  19. to buy a Risc PC so I have no idea whether it will work on one. The
  20. templates are set up so as to remain properly aligned when used with a
  21. proportional font, so it theoretically should work on Risc PC...
  22.  
  23. What's not included
  24. -------------------
  25.  
  26. As well as this program, you'll need a copy of the POV program itself. This
  27. is normally run from the command line - the front end program simply passes
  28. the parameters which you select to it. A copy of the POV program should be
  29. available from many PD sites - you will need version 2.x (currently V2.2 at
  30. time of writing). If you have Internet/JANET access, then it is available
  31. by ftp from micros.hensa.ac.uk. Alternatively, if you have a C compiler, you
  32. can get the source code by ftp from alfred.ccs.carleton.ca, and compile it
  33. yourself. You will also need a copy of the include files, again, these
  34. should be available from the places mentioned above. 
  35.  
  36. Setting up
  37. ----------
  38.  
  39. Assuming you've got a copy of the POV executable program, you'll need to
  40. install it. Open the !POVray2 directory by double clicking on it with
  41. [SHIFT] held down, and copy the executable into it by dragging it using the
  42. Select button. !POVray2 expects the executable to have a filename "POVray2",
  43. so if this is not the case then rename it. If you have a floating point
  44. unit, use an executable compiled using ylib.
  45.  
  46. Running !POVray2
  47. ---------------
  48.  
  49. Double click the icon as normal to run. !POVray2 will then install its icon
  50. onto the icon bar.
  51.  
  52. Open the main window by clicking on the icon, or, alternatively, by dragging
  53. a POV scene description file (filetype &376 or &FFF (text)) onto the icon.
  54. Most of the icons in the window are fairly self explanatory. The width and
  55. height are specified by clicking on the appropriate writeable icon. Clicking
  56. on the 'Partial' icon will select a partial trace. Specify the start and end
  57. positions in the writeable icons.
  58.  
  59. If you have previously aborted a trace, clicking on the 'Continue' icon will
  60. cause the ray tracer to read in the aborted file and continue it. This
  61. option is only available if you are NOT using the 'Use save box' option.
  62. This will be explained later...
  63.  
  64. The V1.00 icon, if selected, will cause the ray tracer to use input
  65. compatible with POV version 1.00, to enable you to trace scene files
  66. produced for the earlier version of POV.
  67.  
  68. !POVray2 has two modes of operation. If the 'Use save box' icon is selected,
  69. then when the trace has been completed, the image can be saved in the usual
  70. RISC OS way using the save option from the main menu (accessed by clicking
  71. Menu in the main window) and dragging the save icon. This method requires
  72. there to be enough space in the scrap directory to hold the final image.
  73. The save icon displayed (and hence the filetype of the final output) depends
  74. upon the output format selected - Targa and DKB files have their own
  75. filetypes. If you have seleced 'Raw RGB files', then the save box will
  76. represent a directory - dragging this creates a directory containing the
  77. separate red green and blue files.
  78.  
  79. The other mode applies if the 'Use save box' icon is not selected. In this
  80. case, the image output is saved into the directory specified in the 'Path'
  81. sub-menu, under the same leaf name as the input file. You can use system
  82. variables here (as an example, the initial default uses the variable
  83. <POVpicture$Dir>), but make sure they have been defined before you use
  84. them (invalid pathnames should (hopefully) be detected...) As before,
  85. filetype is set according to the format selection, with 'Raw RGB files'
  86. creating a directory containing the raw files. As you may appreciate from
  87. this, !POVray2 can only know the precise output filename before the trace if
  88. 'Use save box' mode is off (using a save box, you don't determine the save
  89. name until the trace is finished). This is the reason you can't use
  90. 'Continue' with a save box - the ray tracer doesn't know where to find the
  91. output file to read it in.
  92.  
  93. The format of the output is specified by the top right group of radio icons.
  94. The group of icons below this select the quality of the output.
  95. Anti-aliasing and jittering are selected by the icons below this.
  96.  
  97. The rays per pixel icon specifies the number of rays per pixel when
  98. anti-aliasing, and the frame clock icon specifies the value of the frame
  99. clock variable supplied to the ray tracer.
  100.  
  101. From the main menu, you can select the input library to search for the
  102. #include files, the path (for output if 'Use save box' mode is off), the
  103. output buffer, bounding slabs and symbol table size. The Path, Buffer, and
  104. Use slabs menu items are ticked if selected. If unticked, then that option
  105. is not used in tracing (eg. bounding slabs are only used if the option is
  106. ticked in the menu).
  107.  
  108. Normally, ray tracing takes over all of the processor time. If however you
  109. select 'Task window' from the main menu, the ray tracer will be run in a
  110. Task Window, and hence multi-task. If this is selected, however, it is not
  111. possible to use the save box option, and verbose output is not provided
  112. during the trace. Also, the filetype of the output file will not be set
  113. automatically.
  114.  
  115. The start and cancel icons are probably obvious.....
  116.  
  117. Clicking menu on the icon bar icon will open another menu. From this, you
  118. can quit the application, or save the defaults. This will save the status of
  119. the width, height, save box, rays per pixel, format, quality, anti-aliasing,
  120. jittering, library, output path, bounding slabs, and symbol table size into
  121. a default file. These values are restored whenever the application is
  122. started. 
  123.  
  124. If something goes wrong during the trace, try increasing the size of the
  125. 'Next' slot in the task manager before clicking on 'Start'.
  126.  
  127. !POVray2 has two sets of window templates; the normal ones, and RISC OS 3
  128. !NewLook style windows. These are automatically selected according to 
  129. whether bit 1 of CMOS byte &8C is set - if you have RISC OS 3.1 or better
  130. and have selected 3D windows in !NewLook, then !POVray2 will use 3D
  131. windows, otherwise it will use normal 2D windows. RISC OS 3 support also
  132. includes the use of solid icon drags - if you have the DragASprite bit
  133. in CMOS RAM set, then !POVray2 will use DragASprite solid icon drags in the
  134. save boxes.
  135.  
  136. For more information on POV, refer to the POV documentation, which will
  137. explain the various options and parameters described above in greater
  138. detail.
  139.  
  140. Further Information
  141. -------------------
  142.  
  143. !POVray2 is simply a front end for the Persistence of Vision Ray Tracer, and
  144. is in no way a part of the POV distribution; the POV team are not
  145. responsible in any way for it. The program is freeware - you may distribute
  146. copies of it by any means, provided that:
  147.  
  148. 1.) It is distributed as is, with no modifications to any part of it. This
  149.     document must be included.
  150. 2.) You may not make any charge for it except to cover the cost of disc
  151.     copying and postage and packing etc.
  152.  
  153. The POV executable file should not be distributed as a part of this program.
  154. It is part of a seperate distribution, and has its own rules which cover
  155. this - see the relevant parts of the POV documentation.
  156.  
  157. No claim is made as to the suitability of this program, and I am not in
  158. any way responsible for any loss occurring through its use.
  159.  
  160.  
  161. Well, now that's that out of the way, I hope you find this program useful -
  162. I certainly find it easier than typing out voluminous command lines each
  163. time. I've tried to debug it thoroughly, but I'll bet there are hundreds of
  164. 'undocumented features' floating around. Ah well.... You may send me any
  165. reports of bugs, or comments and suggestions by e-mail as below (this
  166. address is only applicable until June 1996).
  167.  
  168. The program, as I have just found out to my cost, is only as good as the POV
  169. executable you use. Notably, the version I've been using has a bug which
  170. means that the library function does not appear to work. This seems to be a
  171. fault of the executable, not !POVray2.
  172.  
  173. Brian Ruth, February 1994
  174.  
  175. E-mail: b.ruth@ucl.ac.uk